home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 April / macformat-023.iso / Shareware City / Developers / RLaB / help / RLAB < prev    next >
Encoding:
Text File  |  1994-02-21  |  5.0 KB  |  151 lines  |  [TEXT/RLAB]
  1. NAME
  2.      RLaB - matrix oriented, interactive programming environment
  3.  
  4. SYNOPSIS
  5.      rlab [-Vdlmnpqr] [file(s)] [-]
  6.  
  7. DESCRIPTION
  8.      rlab  is   an   interpreter   for   the   RLaB   Programming
  9.      Language/Environment. The RLaB language is useful for matrix
  10.      or array oriented numerical  analyses.  RLaB  is  especially
  11.      useful for prototyping and experimenting with algorithms.
  12.  
  13.      rlab also provides a convenient interface  to  many  of  the
  14.      LAPACK, FFTPACK, and RANLIB subroutines.
  15.  
  16. OPTIONS
  17.      -V   Prints the version number to stderr and exits.
  18.  
  19.      -d   causes a readable form of the internal stack  machine's
  20.           compiled  program  to  be output to stderr. This option
  21.           should be used in conjunction with `-qln' options. This
  22.           option is not intended for general use.
  23.  
  24.      -l   prevents loading of the rlab library of rfiles.
  25.  
  26.      -m   prevents printing of the greeting message.
  27.  
  28.      -n   prevents line number and  file  name  information  from
  29.           being  used  in  the internal stack machine codes. This
  30.           option should only  be  used  with  the  `-dlnq'.  This
  31.           option is not intended for general use.
  32.  
  33.      -p   prevents rlab from using the specified  pager  for  all
  34.           output.
  35.  
  36.      -q   prevents loading of the startup file
  37.  
  38.      -r   prevents usage of the GNU readline library for  command
  39.           line editing.
  40.  
  41.      file(s)
  42.           are loaded and executed by rlab after the `.rlab' file,
  43.           and after the library files.
  44.  
  45.      -    forces rlab to go interactive after all  the  files  on
  46.           the command line have been executed.
  47.  
  48. ENVIRONMENT
  49.      rlab checks the values of several environment variables upon
  50.  
  51. Version 0.95 beta        3 October 1993                         1
  52.  
  53.      startup,  and uses them to overide the compiled in defaults.
  54.      If a particular environment variable has not been  set,  the
  55.      default value is used.
  56.  
  57.      RLAB_RC0 Startup rfile.
  58.  
  59.      RLAB_HELP_DIR The principle directory of help files.
  60.  
  61.      RLAB_LIB_DIR The directory of rfiles to load on startup.
  62.  
  63.      RLAB_PAGER The pager to use for paging  help  files  to  the
  64.      screen.  If  RLAB_PAGER  is not set, then the environment is
  65.      checked for PAGER . If neither exists, then the pager speci-
  66.      fied at compile time is used.
  67.  
  68.      RLAB_SEARCH_PATH The  set  of  directories  to  search  when
  69.      attempting to load rfiles.
  70.  
  71. EXECUTION
  72.      rlab is normally executed from a shell  command  line.  Upon
  73.      startup rlab
  74.  
  75.      Processes the command line options and files.
  76.  
  77.      Executes the `.rlab' file.
  78.  
  79.      Executes any `.r' files in the library directory.
  80.  
  81.      Executes any files specified on the command line.
  82.  
  83.      Goes into interactive mode if no files are specified on the
  84.      command line, or if the `-' option is used.
  85.  
  86.      rlab can also  be  invoked  by  using  the  `#!'  convention
  87.      employed  by exec(2).  A rlab script that begins with a line
  88.      of the form:
  89.  
  90.           #! pathname [arg]
  91.  
  92.      where pathname is the full pathname to the rlab  executable,
  93.      and arg is optional argument(s). Note that if the `-' option
  94.      is not specified rlab will  not  go  interactive  after  the
  95.      script has been executed.
  96.  
  97. DOCUMENTATION
  98.      rlab has an on-line help system, which can  be  accessed  by
  99.      typing  `help'.  A  tutorial  and  a  reference  manual  are
  100.      currently being worked on.
  101.  
  102.      This man-page was not intended to provide a  description  of
  103.  
  104. Version 0.95 beta        3 October 1993                         2
  105.  
  106.      the  language, or rlab's features. Please refer to the manu-
  107.      als, or the on-line help.
  108.  
  109. BUGS
  110.      Paged output gets hosed after an `out of memory' message.
  111.  
  112.      rlab implements fprintf(), printf() and sprintf() using  the
  113.      C  library  functions,  fprintf, printf and sprintf, so rlab
  114.      inherits any bugs or limitations of the library functions.
  115.  
  116.      Using the load()  function  on  the  same  line  as  another
  117.      expression may cause the other expression to be ignored. For
  118.      example:
  119.  
  120.           load ("test.r"); a = 100
  121.  
  122.      Will result in the second expression being ignored. This  is
  123.      caused  by  the  original  syntax  being  used  with the new
  124.      parser/machine capability.  What happens: the tokens for the
  125.      second expression get wiped out when the parser is called to
  126.      start parsing the statements in test.r.  The  workaround  is
  127.      simple;  don't put calls to load() on the same line as other
  128.      expressions. This bug will be fixed in one or two releases.
  129.  
  130.      Send bug reports to: ians@eskimo.com.
  131.  
  132.      Bug reports should include the rlab version number, a  short
  133.      rfile  that exercises the bug, and a description of the host
  134.      operating system and hardware.
  135.  
  136. AUTHORS
  137.      Ian Searle (ians@eskimo.com)
  138.  
  139.      Phillip Musumeci is the author of  the  RLaB  Tutorial  (Not
  140.      Available Yet)
  141.  
  142.      Brad Hards is the author of the RLaB Reference  Manual  (Not
  143.      Available Yet)
  144.  
  145.      Mike Brennan has contributed some code from mawk.
  146.  
  147. SEE ALSO
  148.      sh (1) more (1) exec (2)
  149.  
  150. Version 0.95 beta        3 October 1993                         3
  151.